Non-Powered Assets API

The Non-Powered Assets  API is a RESTful web service that enables Verizon Connect customers to integrate 3rd party back-office systems with REVEAL to keep non-powered asset information up to date.

Key concepts for using the Non-Powered Asset API methods:

Non-Powered Asset API is offered as a RESTful web service

Standard REST verbs are applied: GET, POST, PUT, DELETE

Non-Powered assets API services: Assets and Groups

Throughout this document, we will reference the unique identifier to be invoked for each of the main objects available to be updated.  The unique identifiers are as follows and can be managed within the Fleetmatics REVEAL account by the same field name.

o Assets = Asset Number

o Groups = Group ID

  This API only interacts with your Non-Powered Asset.  Any Powered Asset trackers you have will need to be queried using the Vehicle API. Asset trackers you have will need to be queried using the Vehicle API.

Note : The returned response will be restricted to the Reveal account's data plan. If the information being queried is outside of the data plan, a "400 Bad Request error "response will be returned. For more details on your account's data plan please reach out to Verizon Connect Customer Support

API Summary Details

API Name	Non-Powered assets API
Endpoint	Non-Powered Assets REST API
Operation	GET, PUT

GET Methods

The following methods enable integrated users to extract an asset s information from REVEAL. These methods can be called for one asset or all assets at a time within REVEAL

Get All Assets

The GET All assets method provides integration users with the ability to retrieve all assets within an account

GET All Assets API Request Header

Operation and Path	GET https://fim.api.us.fleetmatics.com/AST/v1/assets
HOST	fim.api.us.fleetmatics.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET AllAssets sample response

"Asset Number": "A10001",

        "AssetName": "Truck1",

        "Make": "NULL",

        "Model": "NULL",

        "Year": NULL,

        "Notes": "Overdue for a service.",

        "Esn": 65498798465213,

        "PrimaryGroupId": "G10001a",

        "PrimaryGroupName: "West coast fleet - Off Duty"

    },

    {

        "Asset Number": "A10002",

        "AssetName": "Flatbed1",

        "Make": "Null",

        "Model": "null",

        "Year": null,

        "Notes": null,

        "Esn": 13258765265496,

        "PrimaryGroupId": "G10001",

        "PrimaryGroupName: "West coast fleet"

    },

    {

        "Asset Number": "A10003",

        "AssetName": "Flatbed1",

        "Make": "null",

"Model": "null",

        "Year": null,

        "Notes": null,

"Esn": 85655487254847,

        "PrimaryGroupId": null,

        "PrimaryGroupName: "Entire Fleet"

    }

]

GET Location Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Asset Number	A10003	The identifier of the Asset. Internally the ClientAssetId
AssetName	Flatbed1	The name of the Asset. Internally the Label
Make	Null	The make of the Asset
Model	Null	The model of the Asset.
Year	Null	The year of the Asset
Notes	Null	Any notes associated with the Asset
ESN	85655487254847	The electronic serial number (ESN) of the Asset. Internally the IMEI
PrimaryGroupID	null	The identifier of the primary group of the Asset. Internally the ClientGroupId (not the GroupId) of the Group
PrimaryGroupName	Entire fleet	The name of the primary group of the Asset

Note: all of these fields are optional, that is, the value of them in the response may be null.

Returned status code may be

200 if the request was successful

401 if the credentials were invalid

500 if something else went wrong

Get Asset By Asset Number

The GET asset by Asset Number returns the specified asset s information

GET Asset by Asset number API Request Header

Operation and Path	GET https://fim.api.us.fleetmatics.com/AST/v1/assets/{assetnumber}
HOST	fim.api.us.fleetmatics.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Asset by Asset number sample response

{

    "Asset Number": "A10001",

    "AssetName": "Truck1",

    "Make": "Null",

    "Model": "Null",

    "Year": NULL ,

    "Notes": "Overdue for a service.",

    "Esn": 65498798465213,

    "PrimaryGroupId": "G10001a",

    "PrimaryGroupName: "West coast fleet - Off Duty"

}

GET Asset by Asset number Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Asset Number	A10001	The identifier of the Asset. Internally the ClientAssetId
AssetName	Truck1	The name of the Asset. Internally the Label
Make	Null	The make of the Asset
Model	Null	The model of the Asset.
Year	Null	The year of the Asset
Notes	overdue for a service	Any notes associated with the Asset
ESN	85655487254847	The electronic serial number (ESN) of the Asset. Internally the IMEI
PrimaryGroupID	G10001a	The identifier of the primary group of the Asset. Internally the ClientGroupId (not the GroupId) of the Group
PrimaryGroupName	West coast fleet-off duty	The name of the primary group of the Asset

Note: all of these fields are optional, that is, the value of them in the response may be null

Returned status code may be

200 if the request was successful

400 if the Asset Number was invalid

401 if the credentials were invalid

404 if the Asset Number was not found for the account

500 if something else went wrong

Get Asset By Group ID

The GET Asset by Group ID extracts all assets belonging to a specified group

GET Asset by Group ID API Request Header

Operation and Path	GET https://fim.api.us.fleetmatics.com/AST/v1/assets/group/{groupid}
HOST	fim.api.us.fleetmatics.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Asset by Group ID sample response

[

    {

        "Asset Number": "A10001",

        "AssetName": "Truck1",

        "Make": "Null",

        "Model": "Null",

        "Year": Null,

        "Notes": "Overdue for a service.",

        "Esn": 65498798465213,

        "PrimaryGroupId": "G10001a",

        "PrimaryGroupName: "West coast fleet - OffDuty"

    },

    {

        "Asset Number": "A10002",

        "AssetName": "Flatbed1",

        "Make": "Null",

        "Model": "Null",

        "Year": Null,

        "Notes": Null,

        "Esn": 13258765265496,

        "PrimaryGroupId": "G10001",

        "PrimaryGroupName: "West coast fleet"

    },

    {

        "Asset Number": "A10003",

        "AssetName": "Flatbed1",

        "Make": "Null",

        "Model": "Null",

        "Year": null,

        "Notes": null,

        "Esn": 85655487254847,

        "PrimaryGroupId": null,

        "PrimaryGroupName: null

    }

]

GET Asset by Group ID Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Asset Number	A10003	The identifier of the Asset. Internally the ClientAssetId
AssetName	Flatbed1	The name of the Asset. Internally the Label
Make	Null	The make of the Asset
Model	Null	The model of the Asset.
Year	Null	The year of the Asset
Notes	null	Any notes associated with the Asset
ESN	85655487254847	The electronic serial number (ESN) of the Asset. Internally the IMEI
PrimaryGroupID	null	The identifier of the primary group of the Asset. Internally the ClientGroupId (not the GroupId) of the Group
PrimaryGroupName	null	The name of the primary group of the Asset

Notes

Returned status code may be

200 if the groupId was found

400 if the groupId was invalid

401 if the credentials were invalid

404 if the groupId was not found for the account

500 if something else went wrong

PUT Methods

Update Asset By Asset Number

The update Asset by asset number updates information of a specified asset

Update asset by asset number sample request

PUT /v1/assets/A10001

{

    "Asset Number": "A57",

    "AssetName": "Flatbed - 57",

    "Make": Null,

    "Model": "Null",

    "Year": Null,

    "Notes": null,

    "PrimaryGroupId": null,

}

Operation and Path	PUT https://fim.api.us.fleetmatics.com:443/AST/v1/assets/{assetnumber}
HOST	fim.api.us.fleetmatics.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Fleetmatics Integration Manager App ID>, Bearer <token> Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

Update Asset by Asset number sample response

Successful updates have a 204 response.

Notes

Returned status code may be

204 if the update was successful

400 if the Asset Number or the asset were invalid

401 if the credentials were invalid

404 if the Asset Number or the PrimaryGroupId were not found for the account

500 if something else went wrong

Update Asset by Asset Number Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Asset Number	A57	The new identifier to overwrite the Asset Number in the request path The identifier of the Asset. Internally the ClientAssetId
AssetName	Flatbed - 57	The name of the Asset. Internally the Label
Make	Null	The make of the Asset
Model	Null	The model of the Asset.
Year	Null	The year of the Asset
Notes	Null	Any notes associated with the Asset
PrimaryGroupID	Null	The identifier of the primary group of the Asset. Internally the ClientGroupId (not the GroupId) of the Group

Update Primary Group ID By Asset Number

The update Asset by asset number method Sets the primary group of the Asset, identified by Asset Number,to be the group identified by primarygroupid.

Update Primary Group ID sample request

PUT /v1/assets/{Asset Number}/primarygroup/{primarygroupid}

The primarygroupid is a string that is not null or empty and must be no more than 45 characters long.

The Asset Number is a string that is not null or empty and must be no more than 96 characters long.

Update Primary Group ID sample response

Successful updates have a 204 response.

Notes

Returned status code may be

204 if the update was successful

400 if the Asset Number or the group Id were invalid

401 if the credentials were invalid

404 if the Asset Number or the group Id were not found for the account

500 if something else went wrong

The primary group of an Asset may be updated using the UpdateAssetsByAsset NumberAsync endpoint, specifying only (or at least) the PrimaryGroupId.